home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / uu150.zip / SYSOP.DOC < prev    next >
Text File  |  1992-12-25  |  17KB  |  428 lines
  1.  
  2. SYSOP Documentation for Ultimate Universe version 1.50
  3. ------------------------------------------------------
  4.  
  5. *** Searchlight bbs sysops please refer below to the slbbs setup area!
  6.  
  7. *** TRIBBS or OTHER BBS systems should read the SLBBS setup 2a and/or 2b
  8.     and config with DOOR.SYS or DORINFOX.DEF depending on which you
  9.     prefer to use.  Read further down concerning FOSSIL support also
  10.  
  11. ------------
  12.  
  13. This covers four important aspects of setting up Ultimate Universe to
  14. run on your BBS.
  15.  
  16.        1. Passing Player Information to the Game
  17.        2. Searchlight BBS configuration and Menu setup
  18.        3. FILE.DIR, where are the files?
  19.        4. Importing & Exporting.
  20.        5. Communications Support.
  21.  
  22. There is a fifth subject: Configuration Variables. This should be studied
  23. thoroughly. This is covered in the file named "CONFIG.DOC".
  24.  
  25. Once those four items have been handled, Ultimate Universe should consist
  26. of two parts:
  27.  
  28.        1. ULTIMATE.EXE which will be called as a DOOR.
  29.        2. MDAILY.EXE which will be called as an event once per day.
  30.  
  31. DAILY.EXE is the Ultimate Universe Daily Maintenance. It has two
  32. command line parameters. The first is the Dimension to perform Daily
  33. Maintenace on. The second is optional and consists of the word RESET.
  34. RESET is used to reinitialize a Dimension. DAILY 1 RESET would reinitialize
  35. Dimension #1. DAILY 0 RESET reinitializes the Primary Dimension and also all
  36. SHIP and subsidiary files. DAILY 3 would perform Daily Mainenance on
  37. Dimension 3.
  38.  
  39. MDAILY.EXE is merely a small file that runs DAILY for all existing
  40. Dimensions.
  41.  
  42.  
  43. ==============================================================================
  44.  
  45. Passing Player Information to the Game
  46. --------------------------------------
  47.  
  48. The Way Information is Passed to Ultimate Universe depends on the setting of
  49. the Configuration Variable 'Input Type'. (See CONFIG.DOC for details).
  50.  
  51. ------------------------------------------------------------------------------
  52. With Input set to 0 (Stand Alone) all information is prompted for by the game.
  53. This is the intended setting for Home Play and disables all communications
  54. support.
  55.  
  56. ------------------------------------------------------------------------------
  57. With Input set to 1 (Searchlight Support) command line parameters are required:
  58.  
  59.      -Pplayer_name    'The Players Name (no spaces)'
  60.      -Tminutes        'Time Remaining on the Board'
  61.      -C               'Use Color Display (Taken for CONFIG if not included)'
  62.      -N               'Disable ANSI displays (ANSI is used if not included)'
  63.      /Bbaud_rate      '%B parameter format'
  64.      /Pcommport       '%P parameter format'
  65. 'Ultimate -PGARTH_BIGELOW -T50 -C' would allow me to play in color for 50
  66. minutes. Consult your Search Light manual on how to pass these parameters.
  67.  
  68. ------------------------------------------------------------------------------
  69. With Input set to 2 (DORINFOx.DEF Support) parameters are passed by way of a
  70. DORINFOx.DEF file. Using this configuration node number must be passed to
  71. ULTIMATE.
  72. 'ULTIMATE 1' would seek out a DORINFO1.DEF file for the needed parameters.
  73. To use this option the second to the last line of FILE.DIR must also be
  74. modified so the DORINFO is the in the file column and the path to DORINFOx.DEF
  75. is in the path column.
  76.  
  77. ------------------------------------------------------------------------------
  78. With Input set to 3 (Standard DOOR.SYS Support) parameters are passed by way
  79. of the DOOR.SYS file. Unfortunately there are two differing file formats that
  80. are both called DOOR.SYS, this is the most popular of the two. With this
  81. setting selected no parameters are required by ULTIMATE.
  82. To use this option modify the second to the last lime of FILE.DIR (which
  83. probably read 'DORINFO' to read DOOR.SYS. Then change the path in this same
  84. line to read as the path to the DOOR.SYS file.
  85.  
  86. ==============================================================================
  87. What Follows are how to set up Ultimate Universe on an SLBBS:
  88.  
  89.  
  90. SearchLight requires very little communications support and only that is
  91. enabled with this setting.
  92.  
  93.  
  94. SAMPLE BAT FILE:
  95. ----------------
  96. @REM START.BAT
  97. @ECHO OFF
  98. @REM  QUICK START UP AND REROUTE OF INFO FILES.
  99. ULTIMATE.EXE -P%1 -T%2 -%3 /B%4 /P%5
  100. COPY NEWPAPER.UU D:\SLBBS\INCLUDES >NUL
  101. COPY RANK.UU D:\SLBBS\INCLUDES >NUL
  102. EXIT
  103.  
  104.  
  105.      CHANGE PATHNAMES TO APPROPRIATE INCLUDE AREAS IF YOU WANT
  106.      TO HAVE STATS AND NEWSPAPER AS BULLETINS
  107.  
  108.               ---------------------------
  109.               SEARCHLIGHT BBS SYSOP SETUP:
  110.               ---------------------------
  111.  
  112.    Searchlight bbs's can have several different setups depending on what
  113. you are doing with your board.  I will discuss how to do:  SLBBS COMM
  114. SUPPORT or FOSSIL COMM SUPPORT along with the different menu setups you
  115. need to do:
  116.  
  117. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  118. 1. SEARCHLIGHT BBS WITH SEARCHLIGHT STANDARD COMM SUPPORT.
  119.  
  120.     Run your UU CONFIG.EXE and on the first page adjust these items:
  121.  
  122.     Input Method         1        (parameters passed)
  123.     Comm Support         0        (Comm Support Provided externally)
  124.     Video Write Method   0        (BIOS  *DIRECT WILL NOT WORK)
  125.  
  126.       Adjust the other configurable variables to your liking but these
  127. are the important ones for this setup to work over the modem properly.
  128.  
  129. SAMPLE BAT FILE:
  130. ----------------
  131. @REM START.BAT
  132. @ECHO OFF
  133. @REM  QUICK START UP AND REROUTE OF INFO FILES.
  134. ULTIMATE.EXE -P%1 -T%2 -%3
  135. COPY NEWPAPER.UU D:\SLBBS\INCLUDES >NUL
  136. COPY RANK.UU D:\SLBBS\INCLUDES >NUL
  137. EXIT
  138.  
  139.  
  140.      SAMPLE MENU ENTRY FOR SLBBS 2.25 Using SLBBS comm support.
  141.  
  142. 1. Command Name.........  Ultimate
  143. 2. Command Key..........  U
  144. 3. Command Description..  Ultimate Universe
  145.  
  146.     4-9  what your preferances are for security and access
  147.  
  148. 10. Command.............  START.BAT  %U %M %G
  149. 11. Directory Path......  D:\SLBBS\DOORS\UU        (YOUR PATH HERE)
  150. 12. Comm Support........  Standard                 (Standard SL comm support)
  151. 13. Abort Method........  Terminate
  152. 14. Write Protection..... No
  153. 14. Door File...........  None
  154. 15. Pause after door....  Yes                      (UU will prompt also)
  155.  
  156.                          ------------------
  157. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  158. 2a. SEARCHLIGHT BBS WITH FOSSIL DRIVER ALREADY INSTALLED TO RUN THE BBS.
  159.  
  160.      (If you want to run your bbs without a fossil driver but use
  161.       a fossil driver just for UU see section 2b.)
  162.  
  163.     You should already have X00.EXE or BNU.COM already installed via
  164. your AUTOEXEC.BAT or RUNBBS.BAT file before your bbs starts.
  165.  
  166.     Run your UU CONFIG.EXE and on the first page adjust these items:
  167.  
  168.     Input Method         1        (parameters passed)
  169.     Comm Support         2        (FOSSIL Support)
  170.     Video Write Method   0        (BIOS  *direct may work but this is safest)
  171.  
  172.       Adjust the other configurable variables to your liking but these
  173. are the important ones for this setup to work over the modem properly.
  174.  
  175. (The next bat file differs from above by the /P%4 and /B%5 which are
  176.  used to pass the current COMM port and BAUD rate to UU)
  177.  
  178. SAMPLE BAT FILE:
  179. ----------------
  180. @REM START.BAT
  181. @ECHO OFF
  182. @REM  QUICK START UP AND REROUTE OF INFO FILES.
  183. ULTIMATE.EXE -P%1 -T%2 -%3 /P%4 /B%5
  184. COPY NEWPAPER.UU D:\SLBBS\INCLUDES >NUL
  185. COPY RANK.UU D:\SLBBS\INCLUDES >NUL
  186. EXIT
  187.  
  188.  
  189.      SAMPLE MENU ENTRY FOR SLBBS 2.25 Using FOSSIL comm support.
  190.  
  191. 1. Command Name.........  Ultimate
  192. 2. Command Key..........  U
  193. 3. Command Description..  Ultimate Universe
  194.  
  195.     4-9  what your preferances are for security and access
  196.  
  197. 10. Command.............  START.BAT  %U %M %G %P %B  (DONT FORGET %P %B)
  198. 11. Directory Path......  D:\SLBBS\DOORS\UU        (YOUR PATH HERE)
  199. 12. Comm Support........  None             (FOSSIL SUPPORT USED INSTEAD)
  200. 13. Abort Method........  None             (UU SHOULD HANDLE THE TERMINATE)
  201. 14. Write Protection..... No
  202. 14. Door File...........  None
  203. 15. Pause after door....  Yes                      (UU will prompt also)
  204.  
  205.                           --------------------
  206.  
  207. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  208. 2b. SEARCHLIGHT BBS WITH NO FOSSIL DRIVER ALREADY INSTALLED TO RUN THE BBS.
  209.  
  210.     (if you run your SLBBS with its standard comm support but you want to 
  211.      take advantage of the special features in UU available only thru use 
  212.      of a FOSSIL driver to run UU then you need to use the above configuration 
  213.      in 2a but should get a copy of BNU.COM.  We use BNU170.ZIP.  
  214.      Adjustments may be needed to run correctly according to the BNU docs but 
  215.      adjust your start.bat file to this.)
  216.  
  217.      (TRIBBS or OTHER BBS systems should use FOSSIL support and make sure
  218.       that the Input Method in the UU CONFIG.EXE is set to 2,3 or 4
  219.       depending on which Door Info File you are using)
  220.  
  221.  
  222. SAMPLE BAT FILE:
  223. ----------------
  224. @REM START.BAT
  225. @ECHO OFF
  226. @REM  QUICK START UP AND REROUTE OF INFO FILES.
  227. BNU.COM /P2 /M- /L1:19200 /F+
  228. ULTIMATE.EXE -P%1 -T%2 -%3 /P%4 /B%5
  229. BNU.COM /U
  230. COPY NEWPAPER.UU D:\SLBBS\INCLUDES >NUL
  231. COPY RANK.UU D:\SLBBS\INCLUDES >NUL
  232. EXIT
  233.  
  234.       --------
  235. The above bnu command is what works for my setup using COM2 with a
  236. locked baud rate of 19200 and fast ansi screen writes.
  237. the BNU.COM /U uninstalls bnu when the door returns to slbbs.  the rest
  238. of the config for UU should be done as seen in 2a above.
  239.  
  240.        (bnu using COM2 and locked baud of 19200)
  241. BNU.COM /P2 /M- /L1:19200 /F+
  242.        (bnu using COM1 and no locked baud rate)
  243. BNU.COM /P1 /M- /L0:0 /F+
  244.  
  245.      **** SEE YOUR BNU DOCUMENTATION IF YOU NEED HELP WITH BNU ******
  246.  
  247.      The above is a sample of what we use on the Over Board BBS you
  248.  may test and change to your liking.... make sure the path is correct
  249.  
  250. ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  251.  
  252.     If you have any problems setting up you may contact me via these
  253. routes:
  254.  
  255.     TOPHERSOFT BBS       SYSOP         (508)-693-7396
  256.     OVER BOARD BBS       GARTH BIGELOW (508)-693-5344
  257.     OVER BOARD BBS ISG NET ADDRESS:    (91:5/201)  (See below info on echo)
  258.     OVER BOARD BBS SL_NET ADDRESS:     (250:502/1294)
  259.  
  260.     Garth A. C. Bigelow
  261.     RR 620 State Road
  262.     Vienyard Haven, Ma 02568
  263.  
  264.  
  265.  An Ultimate Universe Echo has been started in the ISG_NET (International
  266. Sysops Guild Network), known as:  I_UU.  You may leave messages in there
  267. and they will be echoed back to Over Board BBS (91:5/201).  Network
  268. Mail may be sent to Over Board BBS via a Front Door Style Mailer at
  269. (508)-693-5344. Response is not guarenteed, however the conference is
  270. moderated by me.
  271.  
  272. ===============================================================================
  273.  
  274. FILE.DIR, where are the files?
  275. ------------------------------
  276.  
  277. FILE.DIR is a file that contains the filenames and pathnames to most of the
  278. files used by Ultimate Universe.
  279.  
  280. In modifying this file it is VERY IMPORTANT NOT TO ADD ANY CARRIAGE RETURNS
  281. OR IN ANYWAY CHANGE THE ORDER OF THE LINES. Ultimate Universe finds these
  282. names by their place in the file and not by the file names associated with
  283. them.
  284.  
  285. It is best to start out with all the files in the same directory and for
  286. Ultimate Universe to be run from that directory. If you wish to place files
  287. in other directories you must change FILE.DIR also.
  288. If you leave everything in the current directory the only path that will
  289. need changing is the DORINFO line near the bottom of the file. That should
  290. point to the directory that your board creates its information file.
  291. (Note: this is only necessary when CONFIGURATION VARIABLE Input Type is set
  292. greater than 1.)
  293.  
  294. ================================================================================
  295.  
  296. Importing & Exporting
  297. ---------------------
  298.  
  299. If you do not have a Registered Version of Ultimate Universe ignore this section.
  300.  
  301. Importing & Exporting Ships, physically remove the Ships from the Data Files
  302. and create small ship files that are then downloaded and uploaded to yours and
  303. others boards.
  304.  
  305. The Import Functions calls a BAT file called IMPORT.BAT and passes the name
  306. of the file as the first and only parameter. The directory of the file is
  307. pointed to by the line containing simply 'U' in FILE.DIR.
  308.  
  309. IMPORT.BAT must be created by you to call some third party protocol program
  310. like DSZ to upload the file from Player to your BBS.
  311.  
  312. If possible use a common protocol. Also any prompts that the player will
  313. need should be supplied as echoes in the BAT file.
  314.  
  315. Should the Upload fail it is important that the BAT file delete any residual
  316. part of the Uploaded File.
  317.  
  318. IMPORT.BAT must reside in the ULTIMATE UNIVERSE directory.
  319. ---------------------------------------------------------------------------------
  320.  
  321. The Export Functions calls a BAT file called EXPORT.BAT and passes the name
  322. of the file as the first and only parameter. The directory of the file is
  323. pointed to by the line containing simply 'U' in FILE.DIR.
  324.  
  325. EXPORT.BAT must be created by you to call some third party protocol program
  326. like DSZ to download the file from BBS to your Player.
  327.  
  328. If possible use a common protocol. Also any prompts that the player will
  329. need should be supplied as echoes in the BAT file.
  330.  
  331. Upon suucessful download EXPORT.BAT should delete the downloaded file, as
  332. Ultimate Universe checks for the existance of this file as a sign of download
  333. failure.
  334.  
  335. EXPORT.BAT must reside in the ULTIMATE UNIVERSE directory.
  336.  
  337. ===============================================================================
  338.  
  339. Communications Support
  340. ----------------------
  341.  
  342. Communications Method 1: Internal Comm Support
  343. *This has been disabled as of version 1.41. It will be reinstated in a more
  344.  stable form for 2.00.
  345.  
  346. Communications are handled thru a file called MODEM.DAT. It contains four
  347. line and looks like this:
  348.  
  349.     1 4 0x3f8 200 200
  350.     2 3 0x2f8 200 200
  351.     3 4 0x3f8 200 200
  352.     4 3 0x2f8 200 200
  353.  
  354. The first column is the comm port and must correspond with the line number.
  355. The second column is Interrupt Vector for that comm port.
  356. The third column is the Base Address for that comm port.
  357. The fourth column is the size of the in-coming buffer.
  358. The last column is the size of the transmitting buffer.
  359.  
  360. If your modem uses comm port 1, 2, 3 or 4 in the standard manner you do not
  361. need to change MODEM.DAT. If you have a non-standard modem or one that uses
  362. a higher comm port you will need to correct or add comm port entries in
  363. MODEM.DAT.
  364.  
  365. Warning: This product has been tested up to 9600 baud.
  366.       Beyond that there may be screen display problems. As this is a
  367.       combination of modem speed and computer speed it is best to test
  368.       this individually to see if the display looks okay.
  369.  
  370. ---------------------------------------------------------------------------------
  371. Communications Method 2: Fossil Driver Support
  372.  
  373.     (TRIBBS and OTHER BBS Systems should read this)
  374.  
  375. Use of this method requires installation of a Fossil Driver.
  376. See Fossil Driver Manuals for details.
  377. Exhaustive testing has been done using BNU170 as the fossil driver.
  378. I am assuming that X00 or the like will function as well.
  379.  
  380. To use with the Fossil Driver, pass Port and Baud Rate as outlined above.
  381.  
  382.        (starting your fossil driver inside the START.BAT if not done
  383.         before you start your BBS)
  384.  
  385. Below is a sample bat assuming that in your config you have chosen:
  386.     Input Method        3         (DOOR.SYS)
  387.     Comm Support        2         (FOSSIL)
  388.     video write method  0         (BIOS)
  389.  
  390.    (if your Input Method is 2 for DorinfoX.def then you should put
  391.     your node number after ULTIMATE.EXE  such as:  ULTIMATE.EXE 1
  392.     to execute a DORINFO1.DEF file)
  393.  
  394. SAMPLE BAT FILE:
  395. ----------------
  396. @REM START.BAT
  397. @ECHO OFF
  398. @REM  QUICK START UP AND REROUTE OF INFO FILES.
  399. BNU.COM /P2 /M- /L1:19200 /F+
  400. ULTIMATE.EXE
  401. COPY NEWPAPER.UU D:\SLBBS\INCLUDES >NUL
  402. COPY RANK.UU D:\SLBBS\INCLUDES >NUL
  403. BNU.COM /U
  404. EXIT
  405.       --------
  406. The above bnu command is what works for my setup using COM2 with a
  407. locked baud rate of 19200 and fast ansi screen writes.
  408. the BNU.COM /U uninstalls bnu when the door returns to slbbs.  the rest
  409. of the config for UU should be done as seen in 2a above.
  410.  
  411.        (bnu using COM2 and locked baud of 19200)
  412. BNU.COM /P2 /M- /L1:19200 /F+
  413.        (bnu using COM1 and no locked baud rate)
  414. BNU.COM /P1 /M- /L0:0 /F+
  415.  
  416.      **** SEE YOUR BNU DOCUMENTATION IF YOU NEED HELP WITH BNU ******
  417.  
  418. ---------------------------------------------------------------------------------
  419.  
  420.  
  421.    Registered versions in addition to having the Import and Export function
  422.    also have Multi-dimensions and SPACE MADNESS.  Shareware versions also
  423.    lag at least 1 version behind Registered versions.  To Register please
  424.    see REGIST.FRM
  425.  
  426.  
  427.  
  428.